Get Notifications

GET /api/v1/notifications

Description

Retrieves a list of notifications based on the provided filters and pagination options. This can be used to fetch in-app notifications for specific users or tenants within a date range.

Optional Query Parameters:

Name	Type	Description
`notificationDateRange`	`string`	Date range for the notifications. Format: `YYYY-MM-DD,YYYY-MM-DD`. Example: `2020-11-12,2022-11-15`.
`notificationByUserIds`	`string`	In-App notifications filtered by specific user IDs.
`notificationByTenantIds`	`string`	In-App notifications filtered by specific tenant IDs.
`order`	`string`	Sorting order of the notifications. Available values: `ASC`, `DESC`.
`page`	`string`	The page number for pagination.
`limit`	`string`	The number of notifications to return per page (pagination limit).

Example Request:

curl -X GET "{{baseURL}}/api/v1/notifications" \
     -H "Authorization: Bearer [access_token]" \
     -G \
     --data-urlencode "notificationDateRange=2020-11-12,2022-11-15" \
     --data-urlencode "notificationByUserIds=12345,67890" \
     --data-urlencode "notificationByTenantIds=tenant1,tenant2" \
     --data-urlencode "order=ASC" \
     --data-urlencode "page=1" \
     --data-urlencode "limit=20"

Description​

Description